Integrate with wp-product-info for plugin updates #179

mindctrl · 2024-01-19T16:41:02Z

Description

Adds the functionality required to get plugin update information from WP Engine's wp-product-info service.

Closes #173

Testing

To test the update functionality against the wp-product-info staging environment from your local machine, you can:

temporarily adjust the URL in request_plugin_updates() to point to the staging service (https://wp-product-info-staging.wpesvc.net/v1/plugins/wpgraphql-content-blocks).
change the version number in the main plugin file to 1.0.0 to mimic being on an older version.

Here's a screenshot of an update notice with this installed. Note: this mimics a semver breaking change, so it shows the warning about breaking changes.

To test the pipeline deploy:

Note: the CircleCI pipeline typically only runs when new releases are created in the GitHub repo.

I temporarily removed the when conditions from the CircleCI config. Example deploy to staging here: https://app.circleci.com/pipelines/github/wpengine/wp-graphql-content-blocks/53/workflows/3f78c935-9388-43f4-9d59-d89dee43d7fb
You can view the plugin data in the staging service here: https://wp-product-info-staging.wpesvc.net/v1/plugins/wpgraphql-content-blocks

changeset-bot · 2024-01-19T16:41:06Z

🦋 Changeset detected

Latest commit: d70b65d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@wpengine/wp-graphql-content-blocks	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

includes/WPGraphQLContentBlocks.php

tests/e2e/example.spec.js

mindctrl · 2024-02-05T18:05:21Z

includes/updates/update-functions.php

+ */
+function request_plugin_updates( array $args = [] ) {
+	return wp_remote_get(
+		'https://wp-product-info.wpesvc.net/v1/plugins/wpgraphql-content-blocks',


The staging endpoint is here: https://wp-product-info-staging.wpesvc.net/v1/plugins/wpgraphql-content-blocks

Copied initial setup from the Atlas Headless Extension plugin.

Our integration with the plugin update mechanism outputs a "active" row to display errors when communicating with wp-product-info. This class is used by WP to style the update notices to match the table row.

This library bootstraps itself and there's no need to save to a variable. Saving to an unused variable causes a phpcs violation.

Turns out we don't need it since we're not packaging the plugin zip.

Revert "chore: update textdomain to wpgraphql-content-blocks" This reverts commit f615be5. Revert "chore: update text domain in phpcs config" This reverts commit 4e94575. Revert "chore: rename zip artifact in release workflow" This reverts commit dbc6071. Revert "chore: rename package name in composer.json" This reverts commit b230797. Revert "chore: update plugin directory name in _lib.sh" This reverts commit 5829908. Revert "chore: update plugin filename in versionPlugin.js" This reverts commit 33c3d6e. Revert "chore: update phpcs config to load renamed plugin file" This reverts commit 075cf94. Revert "test: load renamed plugin file when bootstrapping tests" This reverts commit 1aee962. Revert "chore: Rename main plugin file." This reverts commit 2c9bd3d.

blakewilson

@mindctrl Regardless of the testing instructions, at every stage I received the following error:

This happened at all of these stages:

When I first checked out the branch
After I updated the staging link
After I downgraded the version

I made sure to also run composer update and npm install. Am I missing anything else?

blakewilson · 2024-02-13T20:06:24Z

.github/workflows/wp-product-info.yml

+on:
+  release:
+    types: [ published ]


If I remember correctly, a workflow can not call another workflow without some additional config.

https://docs.github.com/en/actions/using-workflows/reusing-workflows#creating-a-reusable-workflow

Since changesets (another workflow) creates our release, I'm not sure this workflow will get triggered. We experienced this before in the faustjs repo.

Here is the PR that we dealt with this on Faust. Thankfully it looks like now there is a way to invoke a workflow from a workflow:

https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow

blakewilson · 2024-02-13T20:30:50Z

@mindctrl Regardless of the testing instructions, at every stage I received the following error:

This happened at all of these stages:

When I first checked out the branch

After I updated the staging link

After I downgraded the version

I made sure to also run composer update and npm install. Am I missing anything else?

When I var_dump the $reason in get_api_error_text, I get the following:

TeresaGobble · 2024-02-13T21:44:55Z

Hi @mindctrl and @blakewilson, I can confirm that I'm seeing the same, across all testing steps.

(The yellow warning box is a symlink tag, and should have that error message at the moment).

Additionally, I interpreted the testing instructions as a change to the endpoint, here:

And a change to the version, here:

And then rebuilding at the root of the repo. I expected to see the update notice after this- please let me know if I've missed a step!

mindctrl · 2024-02-13T22:03:08Z

@blakewilson @TeresaGobble thank you for the reviews!

If the plugin tried to communicate with the service before you changed it to the staging URL, the error you see will be cached for 5 minutes in a transient. You can delete this transient manually using the Transients Manager plugin. Activate and go to Tools > Transients.

I'll take another pass through the code and test things, and will take a closer look at the GitHub Action stuff.

blakewilson · 2024-02-13T22:07:52Z

@blakewilson @TeresaGobble thank you for the reviews!

If the plugin tried to communicate with the service before you changed it to the staging URL, the error you see will be cached for 5 minutes in a transient. You can delete this transient manually using the Transients Manager plugin. Activate and go to Tools > Transients.

I'll take another pass through the code and test things, and will take a closer look at the GitHub Action stuff.

@mindctrl You are right John. After revisiting I can see all is working as expected now!

TeresaGobble · 2024-02-14T02:14:56Z

Thank you @mindctrl , I can confirm that after deleting the transient that I see the update notice:

I want to check in about the pipeline deployment- how can I best support you in catching issues with the pipeline? Everything seems to be working well with your example staging, and I don't immediately see any missing data here.

blakewilson · 2024-02-14T18:06:23Z

After checking again, I can't seem to see the breaking changes notice. I disabled other plugins, but still cant see it. Oddly, you can see auto updates has been disabled, so that's working properly:

TeresaGobble · 2024-02-14T19:01:16Z

@blakewilson , I'm still seeing it- was there a change to something locally? How did you check it during this second peek?

Remove GHA_* parameters from CircleCI config.

mindctrl · 2024-02-21T17:23:52Z

.circleci/config.yml

+              branches:
+                ignore: /.*/
+              tags:
+                only: /^v.*/


I've updated all these to run directly in CircleCI when tags are created, instead of using the GHA to trigger Circle. I ran into some known bugs with the Circle trigger action. This also simplifies things.

blakewilson

LGTM! Nice work @mindctrl

mindctrl commented Feb 5, 2024

View reviewed changes

includes/WPGraphQLContentBlocks.php Show resolved Hide resolved

tests/e2e/example.spec.js Show resolved Hide resolved

mindctrl commented Feb 5, 2024

View reviewed changes

mindctrl added 27 commits February 5, 2024 13:47

test: confirm update callbacks are attached

3173f28

chore: Add updater functions

2f40eb6

chore: Add updater callbacks

e953566

chore: add convenience constants used by updater functionality

5463dc5

chore: load updater files via require_once

c502398

chore: exclude VIP rule for wp_remote_get calls

07d61a7

chore: coding standards

87296e8

chore: add .zipignore

6a93b95

chore: add base CircleCI config.

92946da

Copied initial setup from the Atlas Headless Extension plugin.

chore: Remove unused CircleCI config parts

209fe59

ci: Add GHA_* parameters to CircleCI config

f7a320b

chore: fix test that checks for active plugin count.

171016b

Our integration with the plugin update mechanism outputs a "active" row to display errors when communicating with wp-product-info. This class is used by WP to style the update notices to match the table row.

chore: Add blakewilson/wp-enforce-semver dependency

86532aa

chore: Instantiate EnforceSemVer class

ab3b445

chore: Change support link to GitHub issues

46fdd79

ci: Add stub for wp-product-info.yml workflow

f29354a

chore: Tell SonarQube to ignore "useless instantiation".

74c6230

This library bootstraps itself and there's no need to save to a variable. Saving to an unused variable causes a phpcs violation.

chore: Remove NOSCAN directive in favor of phpcs:ignore.

9f39f13

ci: Test temporarily removing conditions for deploy workflow

03dd9e9

ci: download latest release zip

dc037db

ci: adjust unzip command

2d13641

ci: adjust unzip paths

05d4e8a

ci: adjust paths

e7a601a

ci: debug

2e57369

ci: add the dash 🤦

969b184

ci: mkdir build

02defea

ci: update persist path. Add temp debug info.

90ea24a

mindctrl added 7 commits February 5, 2024 13:47

chore: remove .zipignore.

ed1598e

Turns out we don't need it since we're not packaging the plugin zip.

chore: update plugin filename in versionPlugin.js

33c3d6e

chore: update plugin directory name in _lib.sh

5829908

chore: rename package name in composer.json

b230797

chore: rename zip artifact in release workflow

dbc6071

chore: update text domain in phpcs config

4e94575

chore: update textdomain to wpgraphql-content-blocks

f615be5

mindctrl force-pushed the issue173/wp-product-info branch from 07ca6f6 to f615be5 Compare February 5, 2024 18:47

mindctrl added 2 commits February 5, 2024 14:05

chore: temp remove conditional triggers in CircleCI workflow

c9afb25

ci: restore conditionals in deploy workflow

af7bfb4

mindctrl marked this pull request as ready for review February 6, 2024 14:07

mindctrl requested a review from a team as a code owner February 6, 2024 14:07

mindctrl changed the title ~~WIP: Integrate with wp-product-info for plugin updates~~ Integrate with wp-product-info for plugin updates Feb 6, 2024

mindctrl added 2 commits February 6, 2024 10:13

chore: add changeset

45aea24

blakewilson suggested changes Feb 13, 2024

View reviewed changes

mindctrl added 2 commits February 21, 2024 12:16

ci: update CircleCI config to run deploy jobs on tags

9c67f57

chore: remove wp-product-info deploy workflow.

d70b65d

Remove GHA_* parameters from CircleCI config.

mindctrl commented Feb 21, 2024

View reviewed changes

blakewilson approved these changes Feb 21, 2024

View reviewed changes

mindctrl merged commit 9fab724 into main Feb 21, 2024
5 of 7 checks passed

mindctrl deleted the issue173/wp-product-info branch February 21, 2024 18:12

mindctrl mentioned this pull request Feb 28, 2024

CircleCI deploy fails due to restricted context #198

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate with wp-product-info for plugin updates #179

Integrate with wp-product-info for plugin updates #179

mindctrl commented Jan 19, 2024 •

edited

Loading

changeset-bot bot commented Jan 19, 2024 •

edited

Loading

mindctrl Feb 5, 2024

blakewilson left a comment •

edited

Loading

blakewilson Feb 13, 2024

blakewilson Feb 13, 2024 •

edited

Loading

blakewilson commented Feb 13, 2024 •

edited

Loading

TeresaGobble commented Feb 13, 2024 •

edited

Loading

mindctrl commented Feb 13, 2024

blakewilson commented Feb 13, 2024

TeresaGobble commented Feb 14, 2024

blakewilson commented Feb 14, 2024

TeresaGobble commented Feb 14, 2024 •

edited

Loading

mindctrl Feb 21, 2024

blakewilson left a comment

Integrate with wp-product-info for plugin updates #179

Integrate with wp-product-info for plugin updates #179

Conversation

mindctrl commented Jan 19, 2024 • edited Loading

Description

Testing

To test the update functionality against the wp-product-info staging environment from your local machine, you can:

To test the pipeline deploy:

changeset-bot bot commented Jan 19, 2024 • edited Loading

🦋 Changeset detected

mindctrl Feb 5, 2024

Choose a reason for hiding this comment

blakewilson left a comment • edited Loading

Choose a reason for hiding this comment

blakewilson Feb 13, 2024

Choose a reason for hiding this comment

blakewilson Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

blakewilson commented Feb 13, 2024 • edited Loading

TeresaGobble commented Feb 13, 2024 • edited Loading

mindctrl commented Feb 13, 2024

blakewilson commented Feb 13, 2024

TeresaGobble commented Feb 14, 2024

blakewilson commented Feb 14, 2024

TeresaGobble commented Feb 14, 2024 • edited Loading

mindctrl Feb 21, 2024

Choose a reason for hiding this comment

blakewilson left a comment

Choose a reason for hiding this comment

mindctrl commented Jan 19, 2024 •

edited

Loading

changeset-bot bot commented Jan 19, 2024 •

edited

Loading

blakewilson left a comment •

edited

Loading

blakewilson Feb 13, 2024 •

edited

Loading

blakewilson commented Feb 13, 2024 •

edited

Loading

TeresaGobble commented Feb 13, 2024 •

edited

Loading

TeresaGobble commented Feb 14, 2024 •

edited

Loading